passport-oauth1

What is passport-oauth1?

The `passport-oauth1` package is a Passport strategy for authenticating with OAuth 1.0a providers. It allows applications to authenticate users using OAuth 1.0a, a protocol for authorization that enables third-party applications to obtain limited access to a user's resources without exposing their credentials.

What are passport-oauth1's main functionalities?

OAuth 1.0a Authentication

This feature allows you to set up OAuth 1.0a authentication in your application. The code sample demonstrates how to configure the OAuth strategy with the necessary URLs and credentials, and how to handle the authenticated user's profile.

const passport = require('passport');
const OAuthStrategy = require('passport-oauth1').Strategy;

passport.use(new OAuthStrategy({
    requestTokenURL: 'https://www.example.com/oauth/request_token',
    accessTokenURL: 'https://www.example.com/oauth/access_token',
    userAuthorizationURL: 'https://www.example.com/oauth/authorize',
    consumerKey: 'your-consumer-key',
    consumerSecret: 'your-consumer-secret',
    callbackURL: 'https://www.example.com/auth/example/callback'
  },
  function(token, tokenSecret, profile, done) {
    User.findOrCreate({ exampleId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Token Handling

This feature demonstrates how to handle and store OAuth tokens. The code sample shows how to save the token and tokenSecret for later use, which is essential for making authenticated requests on behalf of the user.

passport.use(new OAuthStrategy({
    requestTokenURL: 'https://www.example.com/oauth/request_token',
    accessTokenURL: 'https://www.example.com/oauth/access_token',
    userAuthorizationURL: 'https://www.example.com/oauth/authorize',
    consumerKey: 'your-consumer-key',
    consumerSecret: 'your-consumer-secret',
    callbackURL: 'https://www.example.com/auth/example/callback'
  },
  function(token, tokenSecret, profile, done) {
    // Store the token and tokenSecret for later use
    saveToken(token, tokenSecret);
    User.findOrCreate({ exampleId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

function saveToken(token, tokenSecret) {
  // Save the token and tokenSecret to your database or session
  console.log('Token:', token);
  console.log('Token Secret:', tokenSecret);
}

Other packages similar to passport-oauth1

passport-oauth2

The `passport-oauth2` package is a Passport strategy for authenticating with OAuth 2.0 providers. It is similar to `passport-oauth1` but uses the OAuth 2.0 protocol, which is more modern and widely adopted. It provides a simpler and more secure way to handle authentication compared to OAuth 1.0a.

passport-twitter

The `passport-twitter` package is a Passport strategy specifically for authenticating with Twitter using OAuth 1.0a. It is built on top of `passport-oauth1` and provides a more streamlined and easier-to-use interface for integrating Twitter authentication into your application.

passport-linkedin-oauth2

The `passport-linkedin-oauth2` package is a Passport strategy for authenticating with LinkedIn using OAuth 2.0. It is similar to `passport-oauth1` in terms of functionality but uses the OAuth 2.0 protocol, which is more secure and easier to implement. It is specifically tailored for LinkedIn authentication.

README

passport-oauth1

General-purpose OAuth 1.0 authentication strategy for Passport.

This module lets you authenticate using OAuth in your Node.js applications. By plugging into Passport, OAuth-based sign in can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express.

Note that this strategy provides generic OAuth support. In many cases, a provider-specific strategy can be used instead, which cuts down on unnecessary configuration, and accommodates any provider-specific quirks. See the list for supported providers.

Developers who need to implement authentication against an OAuth provider that is not already supported are encouraged to sub-class this strategy. If you choose to open source the new provider-specific strategy, please add it to the list so other people can find it.

:heart: Sponsors

---

^{Advertisement}
Learn OAuth 2.0 - Get started as an API Security Expert
Just imagine what could happen to YOUR professional career if you had skills in OAuth > 8500 satisfied students

---

...

Install

$ npm install passport-oauth1

Usage

Configure Strategy

The OAuth authentication strategy authenticates users using a third-party account and OAuth tokens. The provider's OAuth endpoints, as well as the consumer key and secret, are specified as options. The strategy requires a verify callback, which receives a token and profile, and calls cb providing a user.

passport.use(new OAuth1Strategy({
    requestTokenURL: 'https://www.example.com/oauth/request_token',
    accessTokenURL: 'https://www.example.com/oauth/access_token',
    userAuthorizationURL: 'https://www.example.com/oauth/authorize',
    consumerKey: EXAMPLE_CONSUMER_KEY,
    consumerSecret: EXAMPLE_CONSUMER_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/example/callback",
    signatureMethod: "RSA-SHA1"
  },
  function(token, tokenSecret, profile, cb) {
    User.findOrCreate({ exampleId: profile.id }, function (err, user) {
      return cb(err, user);
    });
  }
));

Authenticate Requests

Use passport.authenticate(), specifying the 'oauth' strategy, to authenticate requests.

For example, as route middleware in an Express application:

app.get('/auth/example',
  passport.authenticate('oauth'));

app.get('/auth/example/callback', 
  passport.authenticate('oauth', { failureRedirect: '/login' }),
  function(req, res) {
    // Successful authentication, redirect home.
    res.redirect('/');
  });

Related Modules

• passport-oauth2 — OAuth 2.0 authentication strategy
• passport-http-oauth — OAuth authentication strategy for APIs
• oauthorize — OAuth service provider toolkit

Contributing

Tests

The test suite is located in the test/ directory. All new features are expected to have corresponding test cases. Ensure that the complete test suite passes by executing:

$ make test

Coverage

All new feature development is expected to have test coverage. Patches that increse test coverage are happily accepted. Coverage reports can be viewed by executing:

$ make test-cov
$ make view-cov

License

The MIT License

Copyright (c) 2011-2016 Jared Hanson <http://jaredhanson.net/>

Changelog

[1.3.0] - 2023-03-01

Added

• callbackURL property added to metadata passed to request token store.